home *** CD-ROM | disk | FTP | other *** search
/ Aminet 52 / Aminet 52 (2002)(GTI - Schatztruhe)[!][Dec 2002].iso / Aminet / dev / gg / extractor0.1.0.readme < prev    next >
Text File  |  2002-09-14  |  3KB  |  82 lines
  1. Short:    Simple library for keyword extraction
  2. Author:   Vidyut Samanta, Christian Grothoff & Diego Casorran
  3. Uploader: dcr8520@amiga.org
  4. Version:  0.1.0
  5. Type:     dev/gg
  6. Requires: gcc
  7.  
  8. ----------------------------------------------------------------------------
  9.  
  10.         This  package  comes  from      http://Amiga.SourceForge.net
  11.  
  12. ----------------------------------------------------------------------------
  13.  
  14. libExtractor
  15. ============
  16.  
  17. libExtractor is a simple library for keyword extraction.  libExtractor does
  18. not  support all formats but supports a simple plugging mechanism such that
  19. you  can  quickly  add  extractors  for  additional  formats,  even without
  20. recompiling  libExtractor.   libExtractor  typically ships with one or more
  21. helper-libraries   that   can  be  used  to  obtain  keywords  from  common
  22. file-types.
  23.  
  24. If  you want to write your own extractor for some filetype, all you need to
  25. do  is  write  a  little  library that implements a single method with this
  26. signature:
  27.  
  28.  
  29. KeywordList * extract(const char * filename,
  30.                       char * data,
  31.                       size_t size,
  32.               KeywordList * prev);
  33.  
  34.  
  35. The  filename is the name of the file, data is a pointer to the contents of
  36. the file and size is the size of the file.  The extract method must prepend
  37. keywords  that  it finds to the linked list 'prev' and return the new head.
  38. The  library  must  allocate (malloc) the entry in the keyword list and the
  39. memory for the filename since both will be free'ed by libExtractor once the
  40. application calls freeKeywords.
  41. An example implementation can be found in mp3extractor.c.
  42.  
  43. notes  
  44. =====  
  45. Please  note,  if you install libextractor in location that the linker does
  46. not   know   about  (i.e.   is  not  in  /etc/ld.so.conf)  you  /must/  set
  47. LD_LIBRARY_PATH=/path/to/libextractor.   It  is  recommended  that you have
  48. this set in your shells initialization file so that it is always set.  This
  49. can  be  accomplished  in  bash  by  adding the following line to ~/.bashrc
  50. export   LD_LIBRARY_PATH="/path/to/libextractor:$LD_LIBRARY_PATH"   or   in
  51. csh/tcsh  by  adding  the following line to ~/.cshrc setenv LD_LIBRARY_PATH
  52. "/path/to/libextractor:$LD_LIBRARY_PATH"
  53.  
  54.  
  55.  
  56.  
  57.  
  58. ·············································A·r·c·h·i·v·e··C·o·n·t·e·n·t·s··
  59. LhA Freeware Version 2.2
  60. Copyright © 1991-94 by Stefan Boberg.
  61. Copyright © 1998-2000 by Jim Cooper and David Tritscher.
  62.  
  63. Listing of archive 'extractor-0.1.0.lha':
  64. Original  Packed Ratio    Date     Time    Name
  65. -------- ------- ----- --------- --------  -------------
  66.   174080   65461 62.3% 26-Jun-02 06:48:32  !-to-gg.tar
  67.      220     120 45.4% 07-Jun-02 06:49:04  AUTHORS
  68.     1113     579 47.9% 13-Jun-02 04:43:10  ChangeLog
  69.    26430    9650 63.4% 16-May-02 05:03:30  COPYING
  70.      131      97 25.9% 18-May-02 21:36:24  NEWS
  71.     1716     791 53.9% 07-Jun-02 23:04:12  README
  72.       69      63  8.6% 31-Dec-02 23:59:58  source
  73.      303     203 33.0% 07-Jun-02 06:49:04  TODO
  74. -------- ------- ----- --------- --------
  75.   204062   76964 62.2% Operation successful.
  76.  
  77.  
  78.  
  79.  
  80. _____________________________
  81. .Readme created with:  MRea  \
  82.